Skip to main content

Remove-IMAsset

SYNOPSIS​

Removes Immich assets

SYNTAX​

Remove-IMAsset [[-Session] <ImmichSession>] [-Ids] <String[]> [-Force] [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Removes one or more assets from Immich. By default, assets are moved to trash and can be restored. Use the Force parameter to permanently delete assets, bypassing the trash.

EXAMPLES​

EXAMPLE 1​

Remove-IMAsset -Ids 'asset-uuid'

Moves the specified asset to trash with confirmation prompt.

EXAMPLE 2​

@('asset1-uuid', 'asset2-uuid') | Remove-IMAsset

Moves multiple assets to trash via pipeline.

EXAMPLE 3​

Remove-IMAsset -Ids 'asset-uuid' -Force

Permanently deletes the asset, bypassing trash.

EXAMPLE 4​

Get-IMAsset -TagId 'temp-tag' | Remove-IMAsset -Force -Confirm:$false

Permanently deletes all assets with a specific tag without confirmation.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ids​

The UUID(s) of the asset(s) to remove. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: (All)
Aliases: id

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Force​

Performs a permanent deletion bypassing the trash. Assets removed with this flag cannot be restored.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This cmdlet supports ShouldProcess and will prompt for confirmation before removing assets. Use caution with the -Force parameter as it permanently deletes assets.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github